---
layout: typedoc
title: '@msrvida/sanddance-explorer'
---
<header>
<div class="tsd-page-title">
	<div class="typedoc-container">
	</div>
</div>
</header>
<div class="container container-main">
<div class="row">
	<div class="col-8 col-content">
		<section class="tsd-panel-group tsd-index-group">
			<h2>Index</h2>
			<section class="tsd-panel tsd-index-panel">
				<div class="tsd-index-content">
					<section class="tsd-index-section ">
						<h3>Namespaces</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-namespace"><a href="modules/sanddance.html" class="tsd-kind-icon">Sand<wbr>Dance</a></li>
							<li class="tsd-kind-namespace"><a href="modules/controls.html" class="tsd-kind-icon">controls</a></li>
							<li class="tsd-kind-namespace"><a href="modules/util.html" class="tsd-kind-icon">util</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Enumerations</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-enum"><a href="enums/sidetabid.html" class="tsd-kind-icon">Side<wbr>Tab<wbr>Id</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Classes</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-class"><a href="classes/explorer_class.html" class="tsd-kind-icon">Explorer_<wbr><wbr>Class</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Interfaces</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-interface"><a href="interfaces/colorsettings.html" class="tsd-kind-icon">Color<wbr>Settings</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/datacontent.html" class="tsd-kind-icon">Data<wbr>Content</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/datafile.html" class="tsd-kind-icon">Data<wbr>File</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/historicinsight.html" class="tsd-kind-icon">Historic<wbr>Insight</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/historyaction.html" class="tsd-kind-icon">History<wbr>Action</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/historyitem.html" class="tsd-kind-icon">History<wbr>Item</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/options.html" class="tsd-kind-icon">Options</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/prefs.html" class="tsd-kind-icon">Prefs</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/props.html" class="tsd-kind-icon">Props</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/settingsgroup.html" class="tsd-kind-icon">Settings<wbr>Group</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/state.html" class="tsd-kind-icon">State</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/uistate.html" class="tsd-kind-icon">UIState</a></li>
							<li class="tsd-kind-interface"><a href="interfaces/vieweroptions.html" class="tsd-kind-icon">Viewer<wbr>Options</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Type aliases</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-type-alias"><a href="modules.html#dataexporttype" class="tsd-kind-icon">Data<wbr>Export<wbr>Type</a></li>
							<li class="tsd-kind-type-alias"><a href="modules.html#datafiletype" class="tsd-kind-icon">Data<wbr>File<wbr>Type</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Variables</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-variable"><a href="modules.html#explorer" class="tsd-kind-icon">Explorer</a></li>
							<li class="tsd-kind-variable"><a href="modules.html#capabilities" class="tsd-kind-icon">capabilities</a></li>
							<li class="tsd-kind-variable"><a href="modules.html#themepalettes" class="tsd-kind-icon">theme<wbr>Palettes</a></li>
							<li class="tsd-kind-variable"><a href="modules.html#version" class="tsd-kind-icon">version</a></li>
						</ul>
					</section>
					<section class="tsd-index-section ">
						<h3>Functions</h3>
						<ul class="tsd-index-list">
							<li class="tsd-kind-function"><a href="modules.html#getcolorsettingsfromthemepalette" class="tsd-kind-icon">get<wbr>Color<wbr>Settings<wbr>From<wbr>Theme<wbr>Palette</a></li>
							<li class="tsd-kind-function"><a href="modules.html#getembedhtml" class="tsd-kind-icon">get<wbr>EmbedHTML</a></li>
							<li class="tsd-kind-function"><a href="modules.html#use" class="tsd-kind-icon">use</a></li>
						</ul>
					</section>
				</div>
			</section>
		</section>
		<section class="tsd-panel-group tsd-member-group ">
			<h2>Type aliases</h2>
			<section class="tsd-panel tsd-member tsd-kind-type-alias">
				<a name="dataexporttype" class="tsd-anchor"></a>
				<h3>Data<wbr>Export<wbr>Type</h3>
				<div class="tsd-signature tsd-kind-icon">Data<wbr>Export<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="modules.html#datafiletype" class="tsd-signature-type" data-tsd-kind="Type alias">DataFileType</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;html&quot;</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/interfaces.ts#L27">sanddance-explorer/src/interfaces.ts:27</a></li>
					</ul>
				</aside>
			</section>
			<section class="tsd-panel tsd-member tsd-kind-type-alias">
				<a name="datafiletype" class="tsd-anchor"></a>
				<h3>Data<wbr>File<wbr>Type</h3>
				<div class="tsd-signature tsd-kind-icon">Data<wbr>File<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;json&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;csv&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;tsv&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;topojson&quot;</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/interfaces.ts#L10">sanddance-explorer/src/interfaces.ts:10</a></li>
					</ul>
				</aside>
			</section>
		</section>
		<section class="tsd-panel-group tsd-member-group ">
			<h2>Variables</h2>
			<section class="tsd-panel tsd-member tsd-kind-variable">
				<a name="explorer" class="tsd-anchor"></a>
				<h3><span class="tsd-flag ts-flagConst">Const</span> Explorer</h3>
				<div class="tsd-signature tsd-kind-icon">Explorer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="classes/explorer_class.html" class="tsd-signature-type" data-tsd-kind="Class">Explorer_Class</a><span class="tsd-signature-symbol"> = ...</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/explorer.tsx#L1524">sanddance-explorer/src/explorer.tsx:1524</a></li>
					</ul>
				</aside>
			</section>
			<section class="tsd-panel tsd-member tsd-kind-variable">
				<a name="capabilities" class="tsd-anchor"></a>
				<h3><span class="tsd-flag ts-flagConst">Const</span> capabilities</h3>
				<div class="tsd-signature tsd-kind-icon">capabilities<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>webgl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>webgl2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/canvas.ts#L18">sanddance-explorer/src/canvas.ts:18</a></li>
					</ul>
				</aside>
				<div class="tsd-type-declaration">
					<h4>Type declaration</h4>
					<ul class="tsd-parameters">
						<li class="tsd-parameter">
							<h5>webgl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
						</li>
						<li class="tsd-parameter">
							<h5>webgl2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5>
						</li>
					</ul>
				</div>
			</section>
			<section class="tsd-panel tsd-member tsd-kind-variable">
				<a name="themepalettes" class="tsd-anchor"></a>
				<h3><span class="tsd-flag ts-flagConst">Const</span> theme<wbr>Palettes</h3>
				<div class="tsd-signature tsd-kind-icon">theme<wbr>Palettes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/themes.ts#L9">sanddance-explorer/src/themes.ts:9</a></li>
					</ul>
				</aside>
				<div class="tsd-type-declaration">
					<h4>Type declaration</h4>
					<ul class="tsd-parameters">
						<li class="tsd-parameter-index-signature">
							<h5><span class="tsd-signature-symbol">[</span>theme: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FluentUITypes.IPalette</span><span class="tsd-signature-symbol">&gt;</span></h5>
						</li>
					</ul>
				</div>
			</section>
			<section class="tsd-panel tsd-member tsd-kind-variable">
				<a name="version" class="tsd-anchor"></a>
				<h3><span class="tsd-flag ts-flagConst">Const</span> version</h3>
				<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;DEBUG&#x27;</span></div>
				<aside class="tsd-sources">
					<ul>
						<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/version.ts#L4">sanddance-explorer/src/version.ts:4</a></li>
					</ul>
				</aside>
			</section>
		</section>
		<section class="tsd-panel-group tsd-member-group ">
			<h2>Functions</h2>
			<section class="tsd-panel tsd-member tsd-kind-function">
				<a name="getcolorsettingsfromthemepalette" class="tsd-anchor"></a>
				<h3>get<wbr>Color<wbr>Settings<wbr>From<wbr>Theme<wbr>Palette</h3>
				<ul class="tsd-signatures tsd-kind-function">
					<li class="tsd-signature tsd-kind-icon">get<wbr>Color<wbr>Settings<wbr>From<wbr>Theme<wbr>Palette<span class="tsd-signature-symbol">(</span>themePalette<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FluentUITypes.IPalette</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/colorsettings.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorSettings</a><span class="tsd-signature-symbol">&gt;</span></li>
				</ul>
				<ul class="tsd-descriptions">
					<li class="tsd-description">
						<aside class="tsd-sources">
							<ul>
								<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/themes.ts#L61">sanddance-explorer/src/themes.ts:61</a></li>
							</ul>
						</aside>
						<h4 class="tsd-parameters-title">Parameters</h4>
						<ul class="tsd-parameters">
							<li>
								<h5>themePalette: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FluentUITypes.IPalette</span><span class="tsd-signature-symbol">&gt;</span></h5>
							</li>
						</ul>
						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/colorsettings.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorSettings</a><span class="tsd-signature-symbol">&gt;</span></h4>
					</li>
				</ul>
			</section>
			<section class="tsd-panel tsd-member tsd-kind-function">
				<a name="getembedhtml" class="tsd-anchor"></a>
				<h3>get<wbr>EmbedHTML</h3>
				<ul class="tsd-signatures tsd-kind-function">
					<li class="tsd-signature tsd-kind-icon">get<wbr>EmbedHTML<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span>, displayName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, snapshots<span class="tsd-signature-symbol">?: </span><a href="interfaces/sanddance.types.snapshot.html" class="tsd-signature-type" data-tsd-kind="Interface">Snapshot</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
				</ul>
				<ul class="tsd-descriptions">
					<li class="tsd-description">
						<aside class="tsd-sources">
							<ul>
								<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/controls/dataExporter.tsx#L228">sanddance-explorer/src/controls/dataExporter.tsx:228</a></li>
							</ul>
						</aside>
						<h4 class="tsd-parameters-title">Parameters</h4>
						<ul class="tsd-parameters">
							<li>
								<h5>data: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span></h5>
							</li>
							<li>
								<h5>displayName: <span class="tsd-signature-type">string</span></h5>
							</li>
							<li>
								<h5><span class="tsd-flag ts-flagOptional">Optional</span> snapshots: <a href="interfaces/sanddance.types.snapshot.html" class="tsd-signature-type" data-tsd-kind="Interface">Snapshot</a><span class="tsd-signature-symbol">[]</span></h5>
							</li>
						</ul>
						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
					</li>
				</ul>
			</section>
			<section class="tsd-panel tsd-member tsd-kind-function">
				<a name="use" class="tsd-anchor"></a>
				<h3>use</h3>
				<ul class="tsd-signatures tsd-kind-function">
					<li class="tsd-signature tsd-kind-icon">use<span class="tsd-signature-symbol">(</span>fluentUI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FluentUIComponents</span>, react<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">React</span>, reactDOM<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">ReactDOM</span>, vega<span class="tsd-signature-symbol">: </span><a href="interfaces/sanddance.vegadeckgl.types.vegabase.html" class="tsd-signature-type" data-tsd-kind="Interface">VegaBase</a>, deck<span class="tsd-signature-symbol">: </span><a href="interfaces/sanddance.vegadeckgl.types.deckbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckBase</a>, layers<span class="tsd-signature-symbol">: </span><a href="interfaces/sanddance.vegadeckgl.types.decklayerbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckLayerBase</a>, luma<span class="tsd-signature-symbol">: </span><a href="interfaces/sanddance.vegadeckgl.types.lumabase.html" class="tsd-signature-type" data-tsd-kind="Interface">LumaBase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
				</ul>
				<ul class="tsd-descriptions">
					<li class="tsd-description">
						<aside class="tsd-sources">
							<ul>
								<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/base.ts#L40">sanddance-explorer/src/base.ts:40</a></li>
							</ul>
						</aside>
						<div class="tsd-comment tsd-typography">
							<div class="lead">
								<p>Specify the dependency libraries to use for rendering.</p>
							</div>
						</div>
						<h4 class="tsd-parameters-title">Parameters</h4>
						<ul class="tsd-parameters">
							<li>
								<h5>fluentUI: <span class="tsd-signature-type">FluentUIComponents</span></h5>
								<div class="tsd-comment tsd-typography">
									<p>FluentUI React library.</p>
								</div>
							</li>
							<li>
								<h5>react: <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">React</span></h5>
								<div class="tsd-comment tsd-typography">
									<p>React library.</p>
								</div>
							</li>
							<li>
								<h5>reactDOM: <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">ReactDOM</span></h5>
							</li>
							<li>
								<h5>vega: <a href="interfaces/sanddance.vegadeckgl.types.vegabase.html" class="tsd-signature-type" data-tsd-kind="Interface">VegaBase</a></h5>
								<div class="tsd-comment tsd-typography">
									<p>Vega library.</p>
								</div>
							</li>
							<li>
								<h5>deck: <a href="interfaces/sanddance.vegadeckgl.types.deckbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckBase</a></h5>
								<div class="tsd-comment tsd-typography">
									<p>@deck.gl/core library.</p>
								</div>
							</li>
							<li>
								<h5>layers: <a href="interfaces/sanddance.vegadeckgl.types.decklayerbase.html" class="tsd-signature-type" data-tsd-kind="Interface">DeckLayerBase</a></h5>
								<div class="tsd-comment tsd-typography">
									<p>@deck.gl/layers library.</p>
								</div>
							</li>
							<li>
								<h5>luma: <a href="interfaces/sanddance.vegadeckgl.types.lumabase.html" class="tsd-signature-type" data-tsd-kind="Interface">LumaBase</a></h5>
								<div class="tsd-comment tsd-typography">
									<p>@luma.gl/core library.</p>
								</div>
							</li>
						</ul>
						<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
					</li>
				</ul>
			</section>
		</section>
	</div>
	<div class="col-4 col-menu menu-highlight">
		<nav class="tsd-navigation primary">
			<ul>
				<li class="current ">
					<a href="modules.html">Exports</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/sanddance.html">Sand<wbr>Dance</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/controls.html">controls</a>
				</li>
				<li class=" tsd-kind-namespace">
					<a href="modules/util.html">util</a>
				</li>
			</ul>
		</nav>
		<nav class="tsd-navigation secondary">
			<ul class="before-current">
				<li class=" tsd-kind-enum">
					<a href="enums/sidetabid.html" class="tsd-kind-icon">Side<wbr>Tab<wbr>Id</a>
				</li>
				<li class=" tsd-kind-class">
					<a href="classes/explorer_class.html" class="tsd-kind-icon">Explorer_<wbr><wbr>Class</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/colorsettings.html" class="tsd-kind-icon">Color<wbr>Settings</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/datacontent.html" class="tsd-kind-icon">Data<wbr>Content</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/datafile.html" class="tsd-kind-icon">Data<wbr>File</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/historicinsight.html" class="tsd-kind-icon">Historic<wbr>Insight</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/historyaction.html" class="tsd-kind-icon">History<wbr>Action</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/historyitem.html" class="tsd-kind-icon">History<wbr>Item</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/options.html" class="tsd-kind-icon">Options</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/prefs.html" class="tsd-kind-icon">Prefs</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/props.html" class="tsd-kind-icon">Props</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/settingsgroup.html" class="tsd-kind-icon">Settings<wbr>Group</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/state.html" class="tsd-kind-icon">State</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/uistate.html" class="tsd-kind-icon">UIState</a>
				</li>
				<li class=" tsd-kind-interface">
					<a href="interfaces/vieweroptions.html" class="tsd-kind-icon">Viewer<wbr>Options</a>
				</li>
				<li class=" tsd-kind-type-alias">
					<a href="modules.html#dataexporttype" class="tsd-kind-icon">Data<wbr>Export<wbr>Type</a>
				</li>
				<li class=" tsd-kind-type-alias">
					<a href="modules.html#datafiletype" class="tsd-kind-icon">Data<wbr>File<wbr>Type</a>
				</li>
				<li class=" tsd-kind-variable">
					<a href="modules.html#explorer" class="tsd-kind-icon">Explorer</a>
				</li>
				<li class=" tsd-kind-variable">
					<a href="modules.html#capabilities" class="tsd-kind-icon">capabilities</a>
				</li>
				<li class=" tsd-kind-variable">
					<a href="modules.html#themepalettes" class="tsd-kind-icon">theme<wbr>Palettes</a>
				</li>
				<li class=" tsd-kind-variable">
					<a href="modules.html#version" class="tsd-kind-icon">version</a>
				</li>
				<li class=" tsd-kind-function">
					<a href="modules.html#getcolorsettingsfromthemepalette" class="tsd-kind-icon">get<wbr>Color<wbr>Settings<wbr>From<wbr>Theme<wbr>Palette</a>
				</li>
				<li class=" tsd-kind-function">
					<a href="modules.html#getembedhtml" class="tsd-kind-icon">get<wbr>EmbedHTML</a>
				</li>
				<li class=" tsd-kind-function">
					<a href="modules.html#use" class="tsd-kind-icon">use</a>
				</li>
			</ul>
		</nav>
	</div>
</div>
</div>
<div class="overlay"></div>